权限管理接口 | ezoodb 文档

# 权限管理接口

# 接口列表：

认证
创建用户
删除用户
修改密码
重置密码
赋予权限
取消权限
查询用户角色
查询图所属用户
查询所有用户角色

# 认证

# 方法

# def auth(self, username, password)

conn.client("admin", "123456")

# 参数

参数列表	类型	描述	是否可空	默认值	示例	备注
username	String	用户名	否	*	"graph_owner"	符合正则表达式规则 [_A-Za-z0-9]{1,32}
password	String	密码	否	*	"12345678"	符合正则表达式规则 [_A-Za-z0-9]{8,32}

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	Response	认证响应结果	否	*	*

# 创建用户

# 方法

# def create_user(self, username, password, graph, roles)

conn.client.create_user("graph_owner", "12345678", "ezoo", ["graphowner"])

# 参数

参数列表	类型	描述	是否可空	默认值	示例	备注
username	String	用户名	否	*	"graph_owner"	符合正则表达式规则 [_A-Za-z0-9]{1,32}
password	String	密码	否	*	"12345678"	符合正则表达式规则 [_A-Za-z0-9]{8,32}
graph	String	数据库名称	否	*	"ezoo"	不超过32个字符
roles	List	角色列表	是	*	["graphowner"]

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	Response	创建用户响应结果	否	*	*

# 删除用户

# 方法

# def drop_user(self, username)

conn.client.drop_user("graph_owner")

# 参数

参数列表	类型	描述	是否可空	默认值	示例	备注
username	String	用户名	否	*	"graph_owner"	符合正则表达式规则 [_A-Za-z0-9]{1,32}

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	Response	删除用户响应结果	否	*	*

# 修改密码

# 方法

# def change_password(self, old_password, password)

conn.client.change_password("12345678", "87654321")

# 参数

参数列表	类型	描述	是否可空	默认值	示例	备注
old_password	String	需要修改的密码	否	*	"12345678"	[_A-Za-z0-9]{1,32}
password	String	密码	否	*	"87654321"	[_A-Za-z0-9]{8,32}

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	Response	修改密码响应结果	否	*	*

# 重置密码

# 方法

# def reset_password(self, username, password)

conn.client.reset_password("graph_owner", "12345678")

# 参数

参数列表	类型	描述	是否可空	默认值	示例	备注
username	String	用户名	否	*	"graph_owner"	不超过32个字符
password	String	密码	否	*	"12345678"	符合正则表达式规则 [_A-Za-z0-9]{8,32}

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	Response	重置密码响应结果	否	*	*

# 赋予权限

# 方法

# def grant_roles(self, username, graph, roles)

conn.client.grant_roles("graph_owner", "ezoo", ["graph_owner"])

# 参数

参数列表	类型	描述	是否可空	默认值	示例	备注
username	String	用户名	否	*	"graph_owner"	不超过32个字符
graph	String	数据库名称	否	*	"ezoo"	不超过32个字符
roles	List	角色列表	否	*	["graph_owner"]	角色列表必须是内建角色名（小写字母）可参考角色与权限说明

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	Response	赋予权限响应结果	否	*	*

# 取消权限

# 方法

# def cancel_grant_roles(self, username, graph)

conn.client.cancel_grant_roles("graph_owner", "ezoo")

# 参数

参数列表	类型	描述	是否可空	默认值	示例	备注
username	String	用户名	否	*	"graph_owner"	不超过32个字符
graph	String	数据库名称	否	*	"ezoo"	不超过32个字符

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	Response	取消权限响应结果	否	*	*

# 查询用户角色

# 方法

# def view_roles(self, username)

conn.client.view_roles("graph_owner")

# 参数

参数列表	类型	描述	是否可空	默认值	示例	备注
username	String	用户名	否	*	"graph_owner"	不超过32个字符

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	user_roles	查询用户角色响应结果	否	*	*

# 查询图所属用户

# 方法

# def view_users(self, graph)

conn.client.view_users("ezoo")

# 参数

参数列表	类型	描述	是否可空	默认值	示例	备注
graph	String	数据库名称	否	*	"ezoo"	不超过32个字符

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	user_roles	查询图所属用户响应结果	否	*	*

# 查询所有用户角色

当且仅当拥有admin或者root角色的用户能调用该接口。

# 方法

# def view_all_users(self)

conn.client.view_all_users()

# 参数

参数列表	类型	描述	是否可空	默认值	示例	备注

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	user_graph_roles	查询所有用户角色图响应结果	否	*	*

← 图更新接口请求状态码 →